Point Properties
The Point object contains the following read-only properties:
| Property | SubType | Read Only | Description | |
|---|---|---|---|---|
|
AckState |
Integer |
Yes |
Returns the point alarm’s acknowledge state from the point object. To return the alarm acknowledge state, append the ;ack parameter when adding the point. Example
See CasClient Methods for more usage examples. |
|
|
AlarmPriorityCategory |
Long |
Yes |
Returns the point’s alarm priority category. |
|
|
AlternateUnits |
String |
Yes |
Returns the abbreviated form the point’s alternate units. |
|
|
AlternateValue |
String |
Yes |
Returns the point’s alternate value. |
|
|
Comments |
String |
Yes |
Returns the comments for a point from the Point Service. |
|
|
Description |
String |
Yes |
Returns the description of the point from the Current Value Table. |
|
|
Facility |
String |
Yes |
Returns the point facility. |
|
|
FullTag |
String |
Yes |
Returns the full tag of the point. The format is: Site.Service.PointID:LongID. |
|
|
LongDescription |
String |
Yes |
Returns the long description of the point. |
|
|
LongPointID |
String |
Yes |
Returns the Long Point ID. This is the point’s 31 character Long Point ID. |
|
|
LongTag |
String |
Yes |
Returns the long tag of the point. The format is: Site.Service:LongID. |
|
|
PointID |
String |
Yes |
Returns the Point ID. This is the point’s eight character Short Point ID. |
|
|
PointScheme |
Long |
Yes |
Returns the point’s Point Scheme value. |
|
|
PrimaryUnits |
String |
Yes |
Returns the abbreviated form of the point’s primary units. |
|
|
PrimaryValue |
String |
Yes |
Returns the point’s primary value. |
|
|
Integer |
Yes |
Returns the quality of a point that is stored in the cache. The values are defined in the Point Quality enumeration table. |
||
|
Service |
String |
Yes |
Returns the name of the current value service that the point uses. |
|
|
ShortDescription |
String |
Yes |
Returns the short description of the point. |
|
|
Site |
String |
Yes |
Returns the site name. |
|
|
SiteService |
String |
Yes |
Returns the site and service name of the point in "Site.Service" format. |
|
|
Status |
Integer |
Yes |
Returns the base status integer of the point from the Current Value Table |
|
|
System |
String |
Yes |
Returns the system value for the point. "System" is a user-defined field in the PNT header record, which is a TRS entry. Returns the entry, not the table description. |
|
|
Tag |
String |
Yes |
Returns the tag of the point. The format is: Site.Service.PointID. |
|
|
Timestamp |
Date/Time |
Yes |
Returns the timestamp of the point from the Current Value Table (Local time without milliseconds). |
|
| TimestampRaw |
Date/Time |
Yes |
Returns the timestamp of the point from the Current Value Table (UTC time with milliseconds). |
|
|
UDC |
String |
Yes |
Returns the point UDC. |
|
|
Units |
String |
Yes |
Returns the units of the point from the Current Value Table. |
|
|
UserStatus |
Long |
Yes |
Returns the user status bits of the point from the Current Value Table. |
|
|
Value |
String |
Yes |
Returns the value of the point from the Current Value Table. |
